POST Podcast

Overview

---

The following table contains important information about the POST method for managing the process of creating a podcast.

POST Podcast
Method	POST
URL or Endpoint	/api​/v1/projectId​/podcasts
Body	Check the body below

The description of the URL parameters is as follows:

URL Parameter Name	Mandatory	Type	Description
projectId	Yes	string	Unique Id of the project.

Request Body

{
  "title": "string",
  "description": "string",
  "link": "string",
  "author": "string",
  "ownerName": "string",
  "ownerEmail": "string",
  "thumbnailPath": "string",
  "copyright": "string",
  "languageId": 0,
  "explicitOptionId": 0,
  "categories": [
    {
      "id": 0,
      "name": "string",
      "subcategories": [
        {
          "name": "string",
          "id": 0
        }
      ]
    }
  ]
}

Information about the fields that appear on the response body are displayed in the table below.

Parameter Name	Mandatory	Type	Description
title	Yes	string	The title of the podcast.
description	Yes	string	A brief description of the podcast.
link	No	string	A URL link to the podcast.
author	Yes	string	The name of the author of the podcast.
ownerName	Yes	string	The name of the owner of the podcast.
ownerEmail	Yes	string	The email address of the owner.
thumbnailPath	No	string	The path to the thumbnail image for the podcast.
copyright	Yes	string	Copyright information for the podcast.
languageId	Yes	integer	The ID representing the language of the podcast.
explicitOptionId	No	integer	The ID indicating if the podcast has explicit material.
categories	Yes	array[Object]	A list of categories associated with the podcast.
id	Yes	integer	The ID of the category.
name	Yes	string	The name of the category.
subcategories	Yes	array[Object]	A list of subcategories within a category
name	Yes	string	The name of the subcategory.
id	Yes	integer	The ID of the subcategory.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "publicId": "{podcastId}",
    "title": "{tite}",
    "description": "{description}",
    "link": "{link}",
    "author": "{author}",
    "ownerName": "{ownerName}",
    "ownerEmail": "{ownerEmail}",
    "thumbnailUrl": "",
    "thumbnailPath": "",
    "canEmbed": true,
    "copyright": "{copyright}",
    "languageId": 1,
    "explicitOptionId": 1,
    "rssFeedUrl": "https://host.vpplayer.tech/{projectId}/podcast/{podcastId}/rss",
    "explicitOption": {
      "id": 1,
      "name": "True",
      "value": "true"
    },
    "categories": [
      {
        "id": 1,
        "name": "Arts",
        "subcategories": [
          {
            "name": "Books",
            "id": 1
          }
        ]
      }
    ]
  },
  "resultInfo": null,
  "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful, it will return true. Otherwise, it will return false.
errors	array[string]	Indicates if there was an error.
messages	array[string]	Returns the response message from the backend.
result	object	Returns the response object containing the detailed result.
publicId	string	The public identifier for the podcast.
title	string	The title of the podcast.
description	string	A brief description of the podcast.
link	string	A URL link to the podcast.
author	string	The name of the author of the podcast.
ownerName	string	The name of the owner of the podcast.
ownerEmail	string	The email address of the owner.
thumbnailUrl	string	The URL to the thumbnail image for the podcast.
thumbnailPath	string	The path to the thumbnail image for the podcast.
canEmbed	bool	Indicates if the podcast can be embedded.
copyright	string	Copyright information for the podcast.
languageId	integer	The ID representing the language of the podcast.
explicitOptionId	integer	The ID indicating if the podcast has explicit material.
rssFeedUrl	string	The URL of the RSS feed for the podcast.
explicitOption	object	Details about the explicit podcast option.
id	integer	The ID of the explicit option.
name	string	The name of the explicit option.
value	string	The value of the explicit option.
categories	array[object]	A list of categories associated with the podcast
id	integer	The ID of the category.
name	string	The name of the category.
subcategories	array[object]	A list of subcategories within a category.
name	string	The name of the subcategory.
id	integer	The ID of the subcategory.
resultInfo	object	Additional information about the result
statusCode	integer	The HTTP status code of the response.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed